Skip to main content

Agent Permissions

Manage Agent User Permissions


πŸ“Œ What is the Agent Permission Sub-Module?​

In HelloMe, the Agent User Permissions sub-module lets the admin create and manage fine-grained permissions specifically for Agent Users.
This means you can decide exactly what actions an agent user can see or perform inside the Agent portal β€” down to individual buttons, pages, or menu items.


βœ… Purpose​

  • Gives you tight control over what each agent user can do.
  • Works together with Agent Roles β€” each permission can be assigned to one or more roles.
  • Ensures security by letting you hide or show specific features for different agent user types.

πŸ“‹ How it Works​

βœ… User Permission Home Page​

The Manage Agent User Permissions list shows:

  • Label: A human-friendly name for the permission (e.g., Update Profile).
  • Name: A system-friendly name used in the backend (e.g., ag_inward_profile_manage).
  • Route: The route or page link where this permission applies (e.g., # for a placeholder).
  • Guard: Defines which user type the permission applies to (e.g., ag for agent).
  • Created Date: When the permission was added.
  • Action: Edit or delete the permission.


βž• Add Agent User Permission​

When you click Add Agent User Permission, you set up the details of a new permission.

FieldWhat It Means
Name*The backend key for the permission (e.g., ag_inward_profile_manage). Should be unique.
Label*The name that appears on menus or buttons (e.g., Manage Profile).
Show on menuIf checked, this permission will appear as a visible item in the Agent’s sidebar or menu.
Route Name*The route path or link that the permission controls (e.g., /profile/manage).
IconThe icon shown if the permission is a menu item (e.g., fa-regular fa-square-user).
TooltipSmall helper text that appears when a user hovers over the menu item.
ParentLets you link this permission to a parent module (e.g., Self, Manage Agents, Manage Transactions). This groups related permissions together.
Role SpecificLets you choose which roles can see this permission (e.g., All Roles, Sending Agent, Receiving Agent).

| Sort Order | Controls the order in which permissions appear in menus β€” smaller numbers show first. |


πŸ“ Editing an Agent User Permission​

Click Edit on a permission to:

  • Update the label, tooltip, icon, or route.
  • Change the parent group or which roles can see it.
  • Reorder it in the sidebar with Sort Order.
  • Show or hide it from the menu.

πŸ”— How It Ties to Agents & Roles​

βœ… Example Use Case​

Example:

  • You create a permission called Manage Profile.
  • You link it to the Profile Page (Route Name: /profile/manage).
  • You set it to Show on Menu with an icon.
  • You assign it to the Sending Agent role only.

When an agent user with the Sending Agent role logs in:

  • They see Manage Profile in their sidebar.
  • If they don’t have this permission, they can’t access that page at all.

πŸ“Œ Key Points​

  • Agent User Permissions are the building blocks of what an agent user can see or do.
  • They are tied to routes, pages, or actions in the Agent portal.
  • You bundle permissions into roles β€” then assign roles to agent users.
  • Show on Menu turns permissions into visible menu items.
  • Parent and Sort Order keep the menu neat and organised.

In summary:
The Agent User Permissions module keeps your Agent portal secure, flexible, and tailored β€” by giving you total control over what every agent user can access based on their role.